home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / util / cli / 0Utils13.lha / 0Utils / .Conventions < prev    next >
Encoding:
Text File  |  1995-04-07  |  2.4 KB  |  70 lines
  1.  
  2. This is a short list of conventions used when
  3. creating the c-source templates "gen.c.tplt"
  4. and ".c.Template"
  5.  
  6. 1) Each of the Programs in this archive supports
  7.    "C:Version".
  8.  
  9.    * This feature is in fact not to be notable,
  10.      but due to the fact many of the currently
  11.      found programs still do not support it, it
  12.      seemed to be notable. >8)
  13.  
  14. 2) Each of the Programs in this archive supports
  15.    the string "$ARG: " in front of the argument
  16.    template, so other programs can ask for
  17.    the template w/out invoking the program.
  18.    to save some bytes or to support another
  19.    string, the define FORMATPREFIX (def =
  20.    "\0$ARG: ") can be redefined at compiletime.
  21.  
  22.    * Should this header be replaced by ".Key "
  23.      for scripting compability?
  24.  
  25.    * I personally would like to see this becoming
  26.      a standard - so a GUI might ask the user
  27.      for input (instead of the prompt).
  28.  
  29. 3) Each of the Programs in this archive supports
  30.    an additional Flag "/W", if a "/M" Argument
  31.    does allow Patternmatching ( this are in fact
  32.    currently only the FILE/M[/W] arguments for
  33.    the 0Filters archive, if they are compiled with
  34.    "DEFINE PATTERNMATCHING"). Since this additional
  35.    flag _might_ cause problems with other versions
  36.    of dos.library, it can be switched off at compile
  37.    time by redefining WILDCARDFLAG (default = "/W")
  38.  
  39.    * I personally would like to see this flag
  40.      being supported by the OS for the above
  41.      purpose. (if I rewrite dos.library,
  42.      I'll add it =8-))
  43.  
  44. 4) For all Commands the full source is provided.
  45.  
  46.    * I thought this would be normal for freeware
  47.      programs, but in he recent past, I noticed,
  48.      that many - most - of the released programs do
  49.      _not_ include source code. That is imho not
  50.      a very good decision, since nobody can say,
  51.      if the current programs can be run on os4
  52.      (if it comes) w/out recompilation. and if the
  53.      programmers are then still supporting their
  54.      products. 8-\
  55.  
  56. 5) All 'filter' commands in the archive 0Filters
  57.    do accept multiple input files: "FILE/M"
  58.    if no input file is specified, STDIN is used.
  59.    else each of the defined files is used for input.
  60.    if the commands are compiled with the flag
  61.    PATTERNMATCHING, these inputfiles accept wildcards,
  62.    but the executables will grow about 120 Bytes.
  63.  
  64. 6) All 'filter' commands in the archive 0Filters
  65.    do accept target redirection: "TO/K"
  66.    if no target file is specified, STDOUT is used
  67.    for output.
  68.  
  69.  
  70.